ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Splunk Conf File Syntax Highlighting

Syntax highlighting for Splunk .conf files in Sublime Text 2 & 3

Details

Installs

  • Total 6K
  • Win 3K
  • Mac 2K
  • Linux 1K
Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7 Jun 6 Jun 5 Jun 4 Jun 3 Jun 2 Jun 1 May 31 May 30 May 29 May 28 May 27 May 26 May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2
Windows 0 0 0 0 0 2 0 0 0 0 0 0 1 0 0 1 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 2 2 0 0 1 0 0 0
Mac 0 0 0 0 0 0 1 0 0 0 1 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2 0 1 0 0 1
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 1 0 2 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0
01234Jun 16Jun 13Jun 10Jun 7Jun 4Jun 1May 29May 26May 23May 20May 17May 14May 11May 8May 5May 2Jun 16 Linux: 0 Mac: 0 Windows: 0Jun 15 Linux: 0 Mac: 0 Windows: 0Jun 14 Linux: 0 Mac: 0 Windows: 0Jun 13 Linux: 0 Mac: 0 Windows: 0Jun 12 Linux: 0 Mac: 0 Windows: 0Jun 11 Linux: 0 Mac: 0 Windows: 2Jun 10 Linux: 0 Mac: 1 Windows: 0Jun 9 Linux: 0 Mac: 0 Windows: 0Jun 8 Linux: 0 Mac: 0 Windows: 0Jun 7 Linux: 0 Mac: 0 Windows: 0Jun 6 Linux: 0 Mac: 1 Windows: 0Jun 5 Linux: 0 Mac: 0 Windows: 0Jun 4 Linux: 0 Mac: 0 Windows: 1Jun 3 Linux: 0 Mac: 0 Windows: 0Jun 2 Linux: 0 Mac: 0 Windows: 0Jun 1 Linux: 0 Mac: 0 Windows: 1May 31 Linux: 0 Mac: 0 Windows: 0May 30 Linux: 0 Mac: 0 Windows: 0May 29 Linux: 0 Mac: 0 Windows: 0May 28 Linux: 0 Mac: 0 Windows: 0May 27 Linux: 1 Mac: 0 Windows: 0May 26 Linux: 0 Mac: 1 Windows: 1May 25 Linux: 0 Mac: 0 Windows: 0May 24 Linux: 0 Mac: 0 Windows: 0May 23 Linux: 0 Mac: 0 Windows: 0May 22 Linux: 0 Mac: 0 Windows: 0May 21 Linux: 1 Mac: 0 Windows: 0May 20 Linux: 0 Mac: 0 Windows: 0May 19 Linux: 2 Mac: 0 Windows: 0May 18 Linux: 0 Mac: 0 Windows: 0May 17 Linux: 0 Mac: 0 Windows: 0May 16 Linux: 0 Mac: 0 Windows: 0May 15 Linux: 0 Mac: 0 Windows: 1May 14 Linux: 0 Mac: 0 Windows: 0May 13 Linux: 0 Mac: 0 Windows: 0May 12 Linux: 0 Mac: 0 Windows: 0May 11 Linux: 0 Mac: 0 Windows: 0May 10 Linux: 0 Mac: 0 Windows: 0May 9 Linux: 0 Mac: 0 Windows: 2May 8 Linux: 1 Mac: 0 Windows: 2May 7 Linux: 0 Mac: 2 Windows: 0May 6 Linux: 0 Mac: 0 Windows: 0May 5 Linux: 0 Mac: 1 Windows: 1May 4 Linux: 0 Mac: 0 Windows: 0May 3 Linux: 0 Mac: 0 Windows: 0May 2 Linux: 0 Mac: 1 Windows: 0Jun 16 Linux: 0 Mac: 0 Windows: 0Jun 15 Linux: 0 Mac: 0 Windows: 0Jun 14 Linux: 0 Mac: 0 Windows: 0Jun 13 Linux: 0 Mac: 0 Windows: 0Jun 12 Linux: 0 Mac: 0 Windows: 0Jun 11 Linux: 0 Mac: 0 Windows: 2Jun 10 Linux: 0 Mac: 1 Windows: 0Jun 9 Linux: 0 Mac: 0 Windows: 0Jun 8 Linux: 0 Mac: 0 Windows: 0Jun 7 Linux: 0 Mac: 0 Windows: 0Jun 6 Linux: 0 Mac: 1 Windows: 0Jun 5 Linux: 0 Mac: 0 Windows: 0Jun 4 Linux: 0 Mac: 0 Windows: 1Jun 3 Linux: 0 Mac: 0 Windows: 0Jun 2 Linux: 0 Mac: 0 Windows: 0Jun 1 Linux: 0 Mac: 0 Windows: 1May 31 Linux: 0 Mac: 0 Windows: 0May 30 Linux: 0 Mac: 0 Windows: 0May 29 Linux: 0 Mac: 0 Windows: 0May 28 Linux: 0 Mac: 0 Windows: 0May 27 Linux: 1 Mac: 0 Windows: 0May 26 Linux: 0 Mac: 1 Windows: 1May 25 Linux: 0 Mac: 0 Windows: 0May 24 Linux: 0 Mac: 0 Windows: 0May 23 Linux: 0 Mac: 0 Windows: 0May 22 Linux: 0 Mac: 0 Windows: 0May 21 Linux: 1 Mac: 0 Windows: 0May 20 Linux: 0 Mac: 0 Windows: 0May 19 Linux: 2 Mac: 0 Windows: 0May 18 Linux: 0 Mac: 0 Windows: 0May 17 Linux: 0 Mac: 0 Windows: 0May 16 Linux: 0 Mac: 0 Windows: 0May 15 Linux: 0 Mac: 0 Windows: 1May 14 Linux: 0 Mac: 0 Windows: 0May 13 Linux: 0 Mac: 0 Windows: 0May 12 Linux: 0 Mac: 0 Windows: 0May 11 Linux: 0 Mac: 0 Windows: 0May 10 Linux: 0 Mac: 0 Windows: 0May 9 Linux: 0 Mac: 0 Windows: 2May 8 Linux: 1 Mac: 0 Windows: 2May 7 Linux: 0 Mac: 2 Windows: 0May 6 Linux: 0 Mac: 0 Windows: 0May 5 Linux: 0 Mac: 1 Windows: 1May 4 Linux: 0 Mac: 0 Windows: 0May 3 Linux: 0 Mac: 0 Windows: 0May 2 Linux: 0 Mac: 1 Windows: 0Jun 16 Linux: 0 Mac: 0 Windows: 0Jun 15 Linux: 0 Mac: 0 Windows: 0Jun 14 Linux: 0 Mac: 0 Windows: 0Jun 13 Linux: 0 Mac: 0 Windows: 0Jun 12 Linux: 0 Mac: 0 Windows: 0Jun 11 Linux: 0 Mac: 0 Windows: 2Jun 10 Linux: 0 Mac: 1 Windows: 0Jun 9 Linux: 0 Mac: 0 Windows: 0Jun 8 Linux: 0 Mac: 0 Windows: 0Jun 7 Linux: 0 Mac: 0 Windows: 0Jun 6 Linux: 0 Mac: 1 Windows: 0Jun 5 Linux: 0 Mac: 0 Windows: 0Jun 4 Linux: 0 Mac: 0 Windows: 1Jun 3 Linux: 0 Mac: 0 Windows: 0Jun 2 Linux: 0 Mac: 0 Windows: 0Jun 1 Linux: 0 Mac: 0 Windows: 1May 31 Linux: 0 Mac: 0 Windows: 0May 30 Linux: 0 Mac: 0 Windows: 0May 29 Linux: 0 Mac: 0 Windows: 0May 28 Linux: 0 Mac: 0 Windows: 0May 27 Linux: 1 Mac: 0 Windows: 0May 26 Linux: 0 Mac: 1 Windows: 1May 25 Linux: 0 Mac: 0 Windows: 0May 24 Linux: 0 Mac: 0 Windows: 0May 23 Linux: 0 Mac: 0 Windows: 0May 22 Linux: 0 Mac: 0 Windows: 0May 21 Linux: 1 Mac: 0 Windows: 0May 20 Linux: 0 Mac: 0 Windows: 0May 19 Linux: 2 Mac: 0 Windows: 0May 18 Linux: 0 Mac: 0 Windows: 0May 17 Linux: 0 Mac: 0 Windows: 0May 16 Linux: 0 Mac: 0 Windows: 0May 15 Linux: 0 Mac: 0 Windows: 1May 14 Linux: 0 Mac: 0 Windows: 0May 13 Linux: 0 Mac: 0 Windows: 0May 12 Linux: 0 Mac: 0 Windows: 0May 11 Linux: 0 Mac: 0 Windows: 0May 10 Linux: 0 Mac: 0 Windows: 0May 9 Linux: 0 Mac: 0 Windows: 2May 8 Linux: 1 Mac: 0 Windows: 2May 7 Linux: 0 Mac: 2 Windows: 0May 6 Linux: 0 Mac: 0 Windows: 0May 5 Linux: 0 Mac: 1 Windows: 1May 4 Linux: 0 Mac: 0 Windows: 0May 3 Linux: 0 Mac: 0 Windows: 0May 2 Linux: 0 Mac: 1 Windows: 0

Readme

Source
raw.​githubusercontent.​com

Sublime Text syntax highlighting for .conf files

Sublime Text is awesome! But, there's no great way to get syntax highlighting for a Splunk .conf file… until now!

It works with Sublime Text 2 & 3!

Before

before

After

after

Installation

  • Install it from Package Control - search for Splunk Conf File Syntax Highlighting

Manual Installation

  • Clone the repo
  • cd sublime-splunk-conf-highlighting

Sublime Text 2

  • cp splunk-conf.tmLanguage ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/user/splunk-conf.tmLanguage

Sublime Text 3

  • cp splunk-conf.tmLanguage ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/user/splunk-conf.tmLanguage

Patterns

Patterns are used to identify some part of a file.

Patterns used by this package:

  • ^# DO NOT EDIT THIS FILE\\!$ - marks any lines as invalid if they are # DO NOT EDIT THIS FILE!
  • ^#.*$ - marks any lines that start with # as a comment
  • ^\\[.*\\]$ - marks any line starting with [ and ending with ] as a stanza
  • ^[\\w+\\.\\-\\:]+ - marks the beginning of a line as a conf key; defined by any whitespace, alphanumeric, - or : characters
  • = - marks any = as an equals sign

Patterns have 3 main attributes:

  • match (or, begin and end): regex patterns
  • name: a TextMate language grammar group, comment.line for an inline comment
  • comment: a comment about the pattern

Resources

Development Notes

There are 2 important files here:

  • splunk-conf.YAML-tmLanguage - The AAAPackageDev package compiles this to the following, this YAML file is much easier to use
  • splunk-conf.tmLanguage - This is a TextMate language definition file in XML format. SublimeText uses this format, it's a necessary evil.

  • Install package control if you haven't already

  • cmd + shift + P (Mac) or ctrl + shift + P (Windows)

    • Install package
    • AAAPackageDev
  • Open splunk-conf.YAML-tmLanguage

  • cmd + B should update splunk-conf.tmLanguage, make a small change and see if it worked. If not, play with your build system settings under Tools -> Build System

  • During development you'll need to constantly copy the splunk-conf.tmLanguage into your Sublime Text package folder, like so: cp splunk-conf.tmLanguage ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/user/splunk-conf.tmLanguage

  • If something doesn't seem to update, quit & reopen Sublime Text and it should work.